/**
 * Copyright (c) <2010>, <SUNNY GUPTA>
 * All rights reserved.

 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of the <ORGANIZATION> nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <SUNNY GUPTA> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.gwtp.investmentadvisor.server.entities.general;

import java.util.Currency;
import java.util.Locale;

import javax.persistence.Id;
import javax.persistence.Transient;

import com.googlecode.objectify.Key;

/**
 * @author Sunny Gupta
 *
 */
public class Country {

  private static final String DEFAULT_COUNTRY_ID = "IN";
    // Default language is English
  private static final String DEFAULT_LANGUAGE_ID = "EN";
  
  private String countryID;
  private String languageID;
  private Locale locale;
  
  public Country() {
    // Set defaults
    this.countryID = DEFAULT_COUNTRY_ID;
    this.languageID = DEFAULT_LANGUAGE_ID;
    setLocale();
  }
  
  private void setLocale() {
    this.locale = new Locale(this.languageID, this.countryID);
    // Update ID
    setUniqueIdentifier();
  }

  public Locale getLocale() {
    return this.locale;
  }

  public void setCountryID(String countryID) {
    // Only if different
    if (!this.countryID.equals(countryID)) {
      this.countryID = countryID;
      setLocale();
    }
  }

  public String getCountryID() {
    return countryID;
  }

  public void setLanguageID(String languageID) {
    // Only if different
    if (!this.languageID.equals(languageID)) {
      this.languageID = languageID;
      setLocale();
    }
  }

  public String getLanguageID() {
    return languageID;
  }
  
  public String getCountryName() {
    return this.locale.getDisplayCountry();
  }
  
  /**
   * Returns the currency corresponding to the Country.
   * @return
   */
  public Currency getCurrency() {
    return Currency.getInstance(this.locale);
  }
  
  /**
   * Unique Identifier for persistence.
   */
  @Id
  private String uniqueIdentifier;

  /**
   * Need not be stored, but may be required by clients.
   */
  @Transient
  private Key<Country> key;
  
  public Key<Country> getKey() {
    return key;
  }

  private void setUniqueIdentifier() {
    // Use locale as identifier
    this.uniqueIdentifier = this.locale.toString();
    this.key = new Key<Country>(Country.class, this.uniqueIdentifier);
  }

  public String getUniqueIdentifier() {
    return uniqueIdentifier;
  }
}
